<html>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Hammerspoon docs: ClipShow</title>
    <style type="text/css">
      a { text-decoration: none; }
      a:hover { text-decoration: underline; }
      th { background-color: #DDDDDD; vertical-align: top; padding: 3px; }
      td { width: 100%; background-color: #EEEEEE; vertical-align: top; padding: 3px; }
      table { width: 100% ; border: 1px solid #0; text-align: left; }
      section > table table td { width: 0; }
    </style>
    <link rel="stylesheet" href="docs.css" type="text/css" media="screen" />
  </head>
  <body>
    <header>
      <h1><a href="./index.html">docs</a> &raquo; ClipShow</h1>
      <p>Show the content of system clipboard</p>
<p>Download: <a href="https://github.com/Hammerspoon/Spoons/raw/master/Spoons/ClipShow.spoon.zip">https://github.com/Hammerspoon/Spoons/raw/master/Spoons/ClipShow.spoon.zip</a></p>

      </header>
      <h3>API Overview</h3>
      <ul>
        <li>Methods - API calls which can only be made on an object returned by a constructor</li>
          <ul>
            <li><a href="#openInBrowserWithRef">openInBrowserWithRef</a></li>
            <li><a href="#openWithCommand">openWithCommand</a></li>
            <li><a href="#restoreLastSession">restoreLastSession</a></li>
            <li><a href="#saveToFile">saveToFile</a></li>
            <li><a href="#saveToSession">saveToSession</a></li>
            <li><a href="#toggleShow">toggleShow</a></li>
          </ul>
      </ul>
      <h3>API Documentation</h3>
        <h4 class="documentation-section">Methods</h4>
          <section id="openInBrowserWithRef">
            <a name="//apple_ref/cpp/Method/openInBrowserWithRef" class="dashAnchor"></a>
            <h5><a href="#openInBrowserWithRef">openInBrowserWithRef</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>ClipShow:openInBrowserWithRef(refstr)</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Open content of the clipboard in default browser with specific refstr.</p>
<p>Parameters:</p>
<ul>
<li>refstr - A optional string specifying which refstr to use. If nil, then open this content in browser directly. The "refstr" could be something like this: <code>https://www.bing.com/search?q=</code>.</li>
</ul>
</td>
              </tr>
            </table>
          </section>
          <section id="openWithCommand">
            <a name="//apple_ref/cpp/Method/openWithCommand" class="dashAnchor"></a>
            <h5><a href="#openWithCommand">openWithCommand</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>ClipShow:openWithCommand(command)</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Open local file with specific command.</p>
<p>Parameters:</p>
<ul>
<li>command - A string specifying which command to use. The "command" is something like this: <code>/usr/local/bin/mvim</code>.</li>
</ul>
</td>
              </tr>
            </table>
          </section>
          <section id="restoreLastSession">
            <a name="//apple_ref/cpp/Method/restoreLastSession" class="dashAnchor"></a>
            <h5><a href="#restoreLastSession">restoreLastSession</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>ClipShow:restoreLastSession()</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Restore the lastsession of system clipboard</p>
</td>
              </tr>
            </table>
          </section>
          <section id="saveToFile">
            <a name="//apple_ref/cpp/Method/saveToFile" class="dashAnchor"></a>
            <h5><a href="#saveToFile">saveToFile</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>ClipShow:saveToFile()</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Save content of current canvas to a file, the default location is <code>~/Desktop/</code>.</p>
</td>
              </tr>
            </table>
          </section>
          <section id="saveToSession">
            <a name="//apple_ref/cpp/Method/saveToSession" class="dashAnchor"></a>
            <h5><a href="#saveToSession">saveToSession</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>ClipShow:saveToSession()</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Save clipboard session so we can restore it later</p>
</td>
              </tr>
            </table>
          </section>
          <section id="toggleShow">
            <a name="//apple_ref/cpp/Method/toggleShow" class="dashAnchor"></a>
            <h5><a href="#toggleShow">toggleShow</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>ClipShow:toggleShow()</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Process the content of system clipboard and show/hide the canvas</p>
</td>
              </tr>
            </table>
          </section>
  </body>
</html>